Usage Consumption Biz API
CWC UsageConsumptionReport
GET /usageConsumptionReport
Key considerations for CWC (flow markets)
- for CWC Liberate postpaid, data will be retrieved from Liberate and Limeware for BUs(JM,VC,LC,GD,AG,TC,KY,AI,KN,MS,VG,DM). Limeware response gives data balances/usage whereas liberate provides remaining balances/usage. Input parameters are service/subscriber number and account number.
- to retrieve data from Liberate/cerillion. Then service number need to be provided without country code and BU code for all BUs excluding JM and BB. For Jamaica and Barbados, the serviceNumber should be sent including BU code (i.e 876 for JM and 246 for BB).
- for CWC cerillion postpaid, data will be retrieved from Cerillion and Limeware for BUs(BB). Limeware response gives data balances/usage whereas cerillion provides remaining balances/usage. Input parameters are service/subscriber number.
- for CWC prepaid, data will be retrieved from Limeware for BUs(JM,VC,LC,GD,AG,TC,KY,AI,KN,MS,VG,DM,BB). Limeware response gives all the prepaid balances/usage. Input parameters are service/subscriber number.
For sample responses refer below examples:
- CWC Liberate response
- CWC Cerillion response
- CWC Limeware response
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL
http://[localhost]:[port]/tmf-api/usageConsumption/v3/{businessId}/usageConsumptionReportURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PA, TT, BB, JM etc.) identifying the business unit | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | This Client ID must be valid and generate by Operation Team. | Y |
| client_secret | string | This Client Secret must be valid and provisioned by Operation Team. | Y |
| X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layer. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b | N |
Query Param
| name | type | description | required |
|---|---|---|---|
| relatedParty.id | string | unique identifier of the account. This is mandatory when BSS is liberate and searchCriteria.service.@type is POSTPAID | cond Y |
| usageConsumption.logicalResource.id | string | unique identifier EX:ServiceNum | Y |
| searchCriteria.service.@type | String | This is the type Of service. It can be one of [PREPAID, POSTPAID, FIXED] | Y |